|
AlarmAcknowledge
|
No
|
The AlarmAcknowledge method acknowledges an alarm.
|
|
CaptureMouse
|
No
|
The CaptureMouse method forces mouse events to fire. While the mouse is being captured, mouse events will continue to fire on the capturing entity regardless of current mouse position. This function better facilitates dragging objects on views, such as splitters to allow for more flexible layout capabilities. Automatically released on left mouse button release. Context menus are not displayed while capturing. If the function is called on a windowed tool, the function sets capture to that window. If called on a non-windowed tool, it sets capture to The View and tracks which tool is "captured," altering its mouse event functions to always fire for that tool until released.
|
|
ClearMenu
|
No
|
The ClearMenu method clears all custom items from the context menu.
Syntax
ClearMenu()
Parameters
- This method takes no parameters.
Return Values
- This method returns no values.
|
|
ClearSelection
|
Yes
|
ClearSelection clears selection of every note label in the Note Feed Tool.
Syntax
ClearSelection()
Parameters
- This method takes no parameters.
Return Values
- This method returns no values.
See also Notes.
|
|
FacilityConfig
|
No
|
|
|
GetDlgCtrlID
|
No
|
The GetDlgCtrlID method returns the numeric resource identifier of the control within TheView.
|
|
GetGroup
|
No
|
The GetGroup method returns the object group to which an object belongs, and returns null if the object does not belong to a group.
The GroupID property returns the GroupID.
Calling GetGroup is equivalent to calling TheView GetGroupByID and passing the value of the object’s GroupID property, and is provided for convenience.
|
|
GetSelectedNote
|
Yes
|
The GetSelectedNote method returns the SITE.SERVICE~NOTENUMBER of the currently selected note label. A note's database key with no preceding zeroes makes up NOTENUMBER.
Syntax
GetSelectedNote() As String
Parameters
- This method takes no parameters.
Return Values
- This method returns the SITE.SERVICE~NOTENUMBER of the selected note. If no note is selected, the method returns an empty string.
See also Notes.
|
|
HistoryAlarms
|
No
|
The HistoryAlarms method calls the Alarm History dialog box, which shows the alarm history of an individual alarm, and provides options for showing only particular types of alarm events. See Alarm History for more information.
|
|
HistoryValues
|
No
|
The HistoryValues method calls the History Values dialog box, which shows all the history records for a given point, including additional information if the history name came from the PNT. See History Records for more information.
|
|
IsSelected
|
No
|
The IsSelected method indicates if the tool or control is selected. Can be used with [ContextMenuAutoSelect].
|
|
LayerName
|
No
|
The LayerName method gets the name of the layer on which the object resides.
|
|
Move
|
No
|
The Move method moves an object by the specified amount, relative to its current position.
|
|
OnUpdate
|
No
|
The OnUpdate method updates the control to ensure that any property modifications have taken effect.
|
|
OnUpdateResize
|
No
|
The OnUpdateResize method updates the control to ensure that any modifications to its boundary have taken effect.
|
|
OnUpdateStyle
|
No
|
The OnUpdateStyle method updates the control to ensure that any modifications to its style properties have taken effect.
|
|
PointConfigAlarmSettings
|
No
|
|
|
PointConfigAlarmSuppression
|
No
|
|
|
PointConfigAll
|
No
|
|
|
PointConfigComments
|
No
|
|
|
PointConfigQuestionable
|
No
|
|
|
RegisterPointForChangeNotice
|
No
|
The RegisterPointForChangeNotice method registers an unrelated point on a screen that may change its value. Used in conjunction with EventPointChange.
|
|
RemoveMenuItem
|
No
|
|
|
RunInitialize
|
No
|
The RunInitialize method runs the object’s EventInitialize event code.
|
|
RunPumpData
|
No
|
This method is not used.
|
|
Select
|
No
|
The Select
method selects the tool or control. "True" to select, "false" to deselect. Can be used with [ContextMenuAutoSelect].
|
|
SetFocus
|
No
|
The SetFocus method sets the focus to the control.
|
|
SetMenuItem
|
No
|
|
|
SetNotes
|
Yes
|
|
|
SetSelection
|
Yes
|
The SetSelection mode selects a note item in the Note Feed Tool. Both this method and the Trend Tool method SelectNote must be called in order for a Trend Tool and a Note Feed Tool to synchronize. This method fires this tool's EventNoteSelected event.
Syntax
SetSelection(NoteTag As String, SelectionState As Boolean)
Parameters
- NoteTag returns the unique identifier of the selected note in the format SITE.SERVICE~NOTENUMBER.
- SelectionState returns a Boolean value that indicates that a note label is selected (True) or deselected (False).
Return Values
- This method returns a Boolean value that indicates that selection was successful (True) or unsuccessful (False).
See also Notes.
|
|
SetSubMenuItem
|
No
|
|
|
ShowConfiguration
|
No
|
|
|
ShowCurrentValue
|
No
|
|
|
TrendAddPoint
|
No
|
|
|
TrendRemovePoint
|
No
|
|
|
TrendSinglePoint
|
No
|
|
|
TrendSinglePointRollup
|
No
|
|
|
X
|
No
|
The X method returns an object that lists properties and methods specific to an ActiveX control. This method is only available for some ActiveX controls.
|
.gif "X method")
column in the table below indicates whether or not a property or method is accessible using the X method.
